true-case-path

What is true-case-path?

The true-case-path npm package is designed to provide the true case of a filesystem path on a case-insensitive filesystem. This is particularly useful when working with file systems that do not enforce case sensitivity, such as those on Windows and macOS. It helps in ensuring that the path casing matches the actual casing on the filesystem.

What are true-case-path's main functionalities?

Get true case of a file path

This feature allows you to get the true case of a file path. It returns a promise that resolves to the correctly cased path as a string. If the file does not exist, the promise is rejected with an error.

const trueCasePath = require('true-case-path');

trueCasePath('/users/guest/documents/myfile.txt').then((trueCasePath) => {
  console.log(trueCasePath);
}).catch((error) => {
  console.error(error);
});

Other packages similar to true-case-path

case-sensitive-paths-webpack-plugin

This is a Webpack plugin that enforces the entire path of all required modules to match the exact case of the actual path on disk. It is useful for avoiding module resolution issues on case-sensitive file systems or when working across different operating systems. It is similar to true-case-path in that it deals with case sensitivity issues, but it is specifically tailored for Webpack and module resolution rather than general file path usage.

normalize-path

The normalize-path package is used to normalize file paths, ensuring they have consistent slashes and do not include redundant segments. While it does not provide the true case of a path, it is related in the sense that it also deals with file path manipulation and normalization.

path-case

This package provides utilities for converting a string to various case formats, including path case. It does not check the file system for the true case of a path, but it can be used to manipulate strings to have a consistent case format, which can be useful in file path operations.

README

true-case-path

Given a possibly case-variant version of an existing filesystem path, returns the absolute, case-exact, normalized version as stored in the filesystem.

Usage

const { trueCasePath, trueCasePathSync } = require('true-case-path')

trueCasePath(<fileSystemPath>)
    .then((caseCorrectPath) => {
        // ...
    })

const caseCorrectPath = trueCasePathSync(<fileSystemPath>)

NOTE: If no matching path exists, an error with be thrown.

---

Optionally takes a second argument to use as the base path to begin case-correction from. This can be particularly useful within shared hosting environments since true-case-path relies on the ability to list a directory's contents in order to check the case and attempting to list the contents of / or /home will generally result in a permissions error.

const { trueCasePath } = require('true-case-path')

trueCasePath('code/my-app/sOmE-FiLe', '/home/casey')

NOTE: When specifying a basePath, the first argument is expected to be the file path relative to that basePath. If the first argument is absolute, every path segment will be checked. basePath defaults to process.cwd() if not specified and the first argument is relative.

Platforms

Windows, OSX, and Linux

Examples

const { trueCasePathSync } = require('true-case-path')

trueCasePathSync('/users/guest') // OSX: -> '/Users/Guest'

trueCasePathSync('c:\\users\\all users') // Windows: -> 'c:\Users\All Users'